home *** CD-ROM | disk | FTP | other *** search
/ Archive Magazine CD 1995 / Archive Magazine CD 1995.iso / discs / prog_disc / volume_5 / issue_08 / boota / Unshared / !BootA / !Help < prev    next >
Encoding:
Text File  |  1991-12-07  |  8.8 KB  |  254 lines
  1. !BootA  -  RISC OS front-end for non-wimp-based applications
  2. ------------------------------------------------------------
  3.  
  4. Note: The term 'client application' is used below to refer to a
  5.       non-wimp-based application which is 'installed' via the
  6.       !BootA front-end.
  7.  
  8.       The term 'client icon' is used for the client application's
  9.       icon installed by !BootA on the icon bar.
  10.  
  11.  
  12. Starting !BootA
  13. ---------------
  14.  
  15. !BootA is started automatically when you install a client
  16. application by double-clicking on its icon in a directory viewer.
  17. You should double-click on the !BootA icon itself ONLY when you
  18. want to install the list of client applications specified in the
  19. !Init file (see 'Installing Client Applications Automatically'
  20. below).
  21.  
  22.  
  23. Installing a client application on the icon bar
  24. -----------------------------------------------
  25.  
  26. Double-click on the icon for the application in the corresponding
  27. directory viewer. The client icon will be installed at the right
  28. of the icon bar and !BootA will be started if it is not already
  29. active.
  30.  
  31.  
  32. Running the client application
  33. ------------------------------
  34.  
  35. Drag a file or directory icon to the client icon on the icon bar.
  36. This is equivalent to pressing f12 and then entering the
  37. following command:
  38.  
  39.     *RUN  client-appl  object
  40.  
  41. where 'client-appl' is the fully qualified name of the client
  42. application directory and 'object' is the fully qualified name of
  43. the file or directory that was dragged.
  44.  
  45. It is also possible to run the application by just clicking on
  46. the client icon, which is equivalent to the following command:
  47.  
  48.     *RUN  client-appl
  49.  
  50.  
  51. Supplying additional command line input to the client application
  52. -----------------------------------------------------------------
  53.  
  54. Click MENU over a client icon and chose the 'CmdOpts' option. A
  55. window will appear in which you can enter up to 50 characters of
  56. additional information to be passed to the client application.
  57. Press RETURN when you have finished entering the data. Dragging a
  58. file or directory to the client icon will now be equivalent to
  59. entering the following command:
  60.  
  61.     *RUN  client-appl  object  cmdopts
  62.  
  63. The additional information will typically be option flags. Once
  64. entered, the 'CmdOpts' data is retained as long as the client
  65. icon remains displayed on the icon bar. It can be updated at any
  66. time by choosing 'CmdOpts' again from the menu. An initial value
  67. for this 'CmdOpts' data can be supplied by creating a file called
  68. '!CmdOpts' in the client application directory (see supplying
  69. default CmdOpts information below).
  70.  
  71.  
  72. Removing a client application from the icon bar
  73. -----------------------------------------------
  74.  
  75. Click MENU on the client icon and chose 'Quit' from the resulting
  76. menu. The icon will disappear from the icon bar. If it is the
  77. last client icon, !BootA itself will terminate.
  78.  
  79.  
  80. Terminating !BootA
  81. ------------------
  82.  
  83. !BootA will terminate automatically when the last client icon is
  84. removed from the icon bar via the 'Quit' option from the menu.
  85. Alternatively, you can force !BootA to terminate by calling up a
  86. 'Task display' from the task icon (at the extreme right of the
  87. icon bar), clicking the mouse menu button on the display line for
  88. !BootA and chosing 'Quit' from the resulting menu. This will
  89. remove all client icons from the icon bar and terminate !BootA.
  90.  
  91.  
  92. !BootA Menu
  93. -----------
  94.  
  95. Clicking MENU over a client icon will result in a menu with the
  96. following options:
  97.  
  98.  Info:     which displays version information about !BootA.
  99.  
  100.  Help:     which displays brief help text about the client
  101.            application
  102.  
  103.  CmdOpts:  which causes a dialogue window to appear for entering
  104.            or updating the additional input to be passed to the
  105.            client application.
  106.  
  107.  Quit:     which removes the client icon; if this is the only
  108.            client icon to be displayed !BootA will terminate.
  109.  
  110.  
  111. Client Application Directory Format
  112. -----------------------------------
  113.  
  114. The client application directory must contain at least two files:
  115. the !Run file and the !RunA file. The !Run file contains the
  116. commands to start up !BootA and install the client icon. These
  117. commands will normally be:
  118.  
  119.   If "<BootA$Appl>" = ""  then Error BootA cannot be found
  120.   Set BootAclient <Obey$Dir>
  121.   Run <BootA$Appl> <BootAclient>
  122.  
  123. Note that this relies on the variable BootA$Appl being defined.
  124. This is set by the !Boot file in the !BootA application directory
  125. so that before double clicking on any client application, a
  126. directory viewer should be opened for the directory containing
  127. !BootA. The easiest way to do this is to place all the client
  128. applications in the same directory as !BootA itself.
  129.  
  130. The !RunA file should contain the commands to run the client
  131. application itself and so corresponds to the !Run file for a
  132. normal RISC OS application. The core of this file will normally
  133. be a command such as:
  134.  
  135.   Run <Obey$Dir>.!RunImage %*0
  136.  
  137.  
  138. Installing Client Applications Automatically
  139. --------------------------------------------
  140.  
  141. One or more !BootA client applications can be installed
  142. automatically at Desktop start-up time by including a single
  143. command in the DeskTop initialisation file as described in the
  144. Archimedes User Guide. This command should start the !BootA
  145. application itself, specifying the required client applications
  146. as arguments:
  147.  
  148.   e.g. Run adfs::HardDisc4.$.!BootA
  149.            adfs::HardDisc4.$.!Lock  adfs::HardDisc4.$.!Unlock
  150.  
  151. The !BootA application will also accept an initialisation file
  152. containing a list of client applications to be installed:
  153.  
  154.   e.g. Run adfs::HardDisc4.$.!Boot
  155.            -file adfs::HardDisc4.$.!Boot.!Auto
  156.  
  157. The !BootA application directory as distributed includes a file
  158. called '!Auto' which contains a suggested (but ONLY suggested)
  159. list of client applications for starting automatically. There is
  160. also a file called '!Init' which contains a list of all the
  161. example client applications. If you double click on the !BootA
  162. icon, you will install all the client applications in this latter
  163. list.
  164.  
  165.  
  166. Supplying default 'CmdOpts' information
  167. ---------------------------------------
  168.  
  169. When !BootA 'installs' a client application, it looks in the
  170. application directory for a file called '!CmdOpts'. If found, it
  171. will set the 'CmdOpts' data for the application from the file
  172. contents (only first 50 characters will be used). The data in the
  173. file should not contain any newline or other control characters.
  174.  
  175.  
  176. Help support
  177. ------------
  178.  
  179. !BootA provides brief help text when the 'Help' option is chosen
  180. from the menu. It also supports the RISC OS !Help application by
  181. providing the same help message when !Help is active and the
  182. mouse pointer is over the client icon.
  183.  
  184. A standard help message is supplied but a customised message can
  185. be provided for a specific client application by including a file
  186. called '!HelpMsg' in that application's directory which can
  187. contain up to 231 characters of help message. More than 231 will
  188. be truncated. The text should be created without any newline or
  189. other control characters.
  190.  
  191.  
  192. BootA$Object system variable
  193. ----------------------------
  194.  
  195. !BootA sets this system variable to the following values before
  196. running the client application:
  197.  
  198.    FILE     meaning that a file icon was dragged to the client
  199.             icon.
  200.  
  201.    DIR      meaning that a directory icon was dragged to the
  202.             client icon.
  203.  
  204.    APPL     meaning that an application directory icon was
  205.             dragged to the client icon.
  206.  
  207.    NONE     meaning that the client application was started by
  208.             clicking on the client icon and no file or directory
  209.             icon was dragged to it.
  210.  
  211. This system variable can be tested in the client applications
  212. !RunA file to check for error situations and issue the
  213. appropriate message.
  214.  
  215.  
  216. BootA$Type system variable
  217. --------------------------
  218.  
  219. !BootA sets this system variable to the type of the file that was
  220. dragged to the client icon before running the client application.
  221. This type will be the same as that shown in directory viewer in
  222. full display mode - i.e. either 3 digit hex or a filetype name.
  223. If a directory was dragged, BootA$Type is set to 'DIR'. If the
  224. application was run by clicking on its icon (without dragging a
  225. file or directory to it), BootA$Type is set to 'NONE'.
  226.  
  227.  
  228. BootA$Dir system variable
  229. -------------------------
  230.  
  231. !BootA sets this to the name of the directory containing the file
  232. that was dragged to the client icon, or if a directory was
  233. dragged, to the directory name. It will be set to '@' if the
  234. application was run by clicking on its icon without dragging any
  235. file or directory to it.
  236.  
  237.  
  238. BootA$Leaf system variable
  239. --------------------------
  240.  
  241. If a file is dragged to the client icon, !BootA sets this
  242. variable to the leaf-name of the file. In all other cases
  243. (directory dragged or nothing dragged) it is set to a null
  244. string.
  245.  
  246.  
  247. BootA$CmdOpts system variable
  248. -----------------------------
  249.  
  250. !BootA always sets this to the information specified via the
  251. 'CmdOpts' option in the menu (which is initially set from the
  252. contents of the !CmdOpts file in the application directory).
  253.  
  254.